Skip to content

Scaffolding: Federation sync app creation#298

Open
klpoland wants to merge 8 commits into
masterfrom
feature-kpoland-federation-sync-scaffolding
Open

Scaffolding: Federation sync app creation#298
klpoland wants to merge 8 commits into
masterfrom
feature-kpoland-federation-sync-scaffolding

Conversation

@klpoland

@klpoland klpoland commented Jun 19, 2026

Copy link
Copy Markdown
Collaborator

In this PR:

  • [NEW] federation/ (v1) application with:
    • services:
      • bootstrap.py: for initialization of federated data from home site and peers (including when new peer is added)
      • fed_index.py: for handling (external peer) asset indexing on webhook events
      • local_events.py: for handling redis dispatches to fetch local data
      • peer registry.py: for registering new peers and holding site information from site hellos
      • peer_sync.py: for packaging and sending asset data to peer sites (through their webhook routes)
    • routes:
      • health.py: (stub for now) for pinging site health (is connection established?)
      • webhooks.py: for receiving payloads FROM peers to index into LOCAL federated asset indices as well as a site-hello hook to confirm federation between peers
    • schemas and models: for type checking and providing data structures to federation configs, events, and documents (how asset docs are represented by FederatedDatasetDoc, FederatedCaptureDoc may warrant further consideration re: anticipating schema flexibility)
    • a main app that subscribes to redis events for picking up signals from gateway (handled in PR Scaffolding: Federation gateway setup #299)

Note

Medium Risk
New cross-site sync path writes to OpenSearch and accepts peer webhooks; mistakes in origin validation or indexing could propagate bad metadata, though scope is metadata-only and tests cover main flows.

Overview
Introduces a new federation/ FastAPI sync service that keeps federated dataset/capture metadata in OpenSearch and exchanges updates with peer sites.

On startup it can bootstrap from local and peer gateway export APIs, register via site-hello, and run a background Redis subscriber on federation:events (gateway signals from a related change). Local events resolve public export docs, update fed-* indices, and POST asset webhooks to configured peers; inbound /sync/api/v1/webhook/* routes apply the same indexing with allowlisted site_name checks.

Repo wiring adds Docker/Compose, sample federation.toml, dev mTLS cert tooling, and pre-commit hooks (federation-specific ruff/pyrefly/deptry). Coverage is a broad pytest suite (mesh integration, indexer regression, operational health).

Reviewed by Cursor Bugbot for commit d0608d2. Bugbot is set up for automated code reviews on this repo. Configure here.

@klpoland klpoland self-assigned this Jun 19, 2026
@klpoland klpoland added feature New feature or request federation Federation related work (sync service, document storage, peer configuration, etc.) labels Jun 19, 2026
@semanticdiff-com

semanticdiff-com Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review changes with  SemanticDiff

Changed Files
File Status
  .pre-commit-config.yaml  4% smaller
  federation/.envs/example/sync.env Unsupported file format
  federation/.gitignore Unsupported file format
  federation/Dockerfile Unsupported file format
  federation/certs/.gitignore Unsupported file format
  federation/compose.yaml  0% smaller
  federation/federation.toml Unsupported file format
  federation/justfile Unsupported file format
  federation/pyproject.toml Unsupported file format
  federation/scripts/generate-dev-certs.sh Unsupported file format
  federation/scripts/simulate_redis_event.py  0% smaller
  federation/sds_federation/__init__.py  0% smaller
  federation/sds_federation/main.py  0% smaller
  federation/sds_federation/models.py  0% smaller
  federation/sds_federation/routes/__init__.py  0% smaller
  federation/sds_federation/routes/health.py  0% smaller
  federation/sds_federation/routes/webhooks.py  0% smaller
  federation/sds_federation/schemas/__init__.py  0% smaller
  federation/sds_federation/schemas/webhooks.py  0% smaller
  federation/sds_federation/services/__init__.py  0% smaller
  federation/sds_federation/services/bootstrap.py  0% smaller
  federation/sds_federation/services/fed_index.py  0% smaller
  federation/sds_federation/services/local_events.py  0% smaller
  federation/sds_federation/services/operational.py  0% smaller
  federation/sds_federation/services/peer_registry.py  0% smaller
  federation/sds_federation/services/peer_sync.py  0% smaller
  federation/sds_federation/testing/__init__.py  0% smaller
  federation/sds_federation/testing/sample_data.py  0% smaller
  federation/tests/__init__.py  0% smaller
  federation/tests/conftest.py  0% smaller
  federation/tests/support/__init__.py  0% smaller
  federation/tests/support/federation_mesh.py  0% smaller
  federation/tests/support/gateway_export_mock.py  0% smaller
  federation/tests/support/mock_opensearch.py  0% smaller
  federation/tests/support/mock_peer_registry.py  0% smaller
  federation/tests/test_integration_bootstrap.py  0% smaller
  federation/tests/test_integration_mesh.py  0% smaller
  federation/tests/test_integration_pipeline.py  0% smaller
  federation/tests/test_integration_webhooks.py  0% smaller
  federation/tests/test_operational.py  0% smaller
  federation/tests/test_redis_event_pipeline.py  0% smaller
  federation/tests/test_regression_indexer.py  0% smaller
  federation/tests/test_regression_schemas.py  0% smaller
  federation/uv.lock Unsupported file format

@klpoland klpoland changed the title Scaffolding: Federation Sync App Scaffolding: Federation sync app creation Jun 19, 2026
@klpoland klpoland marked this pull request as ready for review June 25, 2026 19:50
@klpoland klpoland requested a review from lucaspar June 25, 2026 19:50
Comment thread federation/sds_federation/services/local_events.py
Comment thread federation/sds_federation/services/local_events.py
Comment thread federation/sds_federation/services/bootstrap.py Outdated
Comment thread federation/compose.yaml Outdated
Comment thread federation/sds_federation/services/local_events.py
Comment thread federation/sds_federation/services/fed_index.py
Comment thread federation/pyproject.toml
Comment thread federation/pyproject.toml Outdated
@lucaspar

Copy link
Copy Markdown
Member

I'll add more comments after those are addressed to reduce the noise

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using high effort and found 3 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit d0608d2. Configure here.

asset=asset,
asset_type=asset_type,
)
await push_asset_updated_to_peers(http, config, payload)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale skip still notifies peers

High Severity

After a Redis event, handle_redis_asset_event always calls push_asset_updated_to_peers, even when FederatedAssetIndexer.apply_asset_event returns early because the event is stale. Peers can receive deletes or older updates that the local indexer intentionally ignored, causing cross-site index drift (for example after bootstrap sets a newer in-memory event_at).

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit d0608d2. Configure here.

body = payload.model_dump(mode="json")
path = payload.asset_type.webhook_path
for peer in config.peers:
url = peer_webhook_url(peer, path)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Outbound sync ignores peer registry

Medium Severity

push_asset_updated_to_peers always uses static config.peers URLs from federation.toml, while site-hello updates PeerRegistry with each peer’s declared sync_service_url. Outbound webhooks never read the registry, so post-hello URL data is unused.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit d0608d2. Configure here.

def _is_stale(self, site_name: str, uuid: UUID, event_at: datetime) -> bool:
key = doc_id(site_name, uuid)
prev = self._last_event.get(key)
return bool(prev is not None and event_at <= prev)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Naive-aware datetime compare crash

Medium Severity

Stale-event dedupe compares event_at from Redis (datetime.fromisoformat without normalizing timezone) against bootstrap/webhook timestamps that are timezone-aware UTC. If the gateway publishes naive ISO timestamps, Python raises TypeError on comparison and can crash indexing or the Redis subscriber loop.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit d0608d2. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New feature or request federation Federation related work (sync service, document storage, peer configuration, etc.)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants